<HTML>
<HEAD>
<TITLE>HELP - Todo</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - Todo</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','ExampleCode0',this)" class="pathLink">Example Code</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_class','HowToDocument0',this)" class="pathLink">HowToDocument</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">Todo</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("","","","");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_member','Todo2587069908','_description',this)" class="tabLinkActive">Description</a></span>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_member','Todo2587069908','_source',this)" class="tabLinkInActive">Source</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Call Graph</span></span>
<script type="text/javascript">
 Body4();
</script>
<div class="contentAirTop"></div>
<span class="paragraph1">HowToDocument::Todo</span>
<span class="padding">( Public Method  )</span>
<div class="paddingAuthor">Author:  N.F.S Grundtvig (The members of this class inherits the author by default.) </div>
<div class="paragraph2">Making todo's (internal use mainly).<br>
</div>
<div class="padding">&nbsp;</div>
<table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderTop" height=1>
<TR><TD height=1 width=100% class="oneLine"></TD></TR></TABLE>
<div class="paragraph2"><span id="descFunSynExpSpan" style="display:none;visibility:hidden"><a href="javascript:showElement( 'descFunSynColSpan' );javascript:hideElement( 'descFunSynExpSpan' );javascript:showElement( 'descFunSyn' );javascript:setMyCookie( cookieName, 'descFunSyn', 'show' );"><img src="../../common/expand.gif" border=0></a></span><span id="descFunSynColSpan"><a href="javascript:showElement( 'descFunSynExpSpan' );javascript:hideElement( 'descFunSynColSpan' );javascript:hideElement( 'descFunSyn' );javascript:setMyCookie( cookieName, 'descFunSyn', 'hide' );"><img src="../../common/collapse.gif" border=0></a></span>
Syntax / parameters</div>
<div id="descFunSyn" class="paddingMembersTableDiv"><table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
<TR VALIGN="top"><TD class="paddingHeadMultiColumn2"><span class="codeFont">void <a href="#" OnMouseOver="link('_member','Todo2587069908',this)">Todo</a> ()<br>
</span></TD></TR></TABLE>
<br></div>
<div class="paragraph2">Description</div>
<div id="descDesc" class="paddingMembers">Making todo's (internal use mainly).<br>
This is done using the keyword: <b><code>\todo</code></b>.<br>
<br>
<a href="#" OnMouseOver="link('_member','Todo2587069908',this)">Todo</a> comments are intended for use by the developers of the code/library and not for the users of the library. You can use TODO_DOCS in the config file to show or hide the todo documentation.<br>
<br>
<div class="userParagraph3">This is how it looks in the source:</div>
  <table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
  <TR VALIGN="top">
  <TD class="paddingHeadMultiColumn2">
<pre class="codeExamples">
\todo We have stuff todo!
</pre>  </TD>
  </TR>
  </TABLE>
<br>
<div class="userParagraph3">About section commands</div>
This command is a section command (also called special section). Common to all section commands is the fact that the section continues until a blank line or another section command is encountered.<br>
<br>
The section commands are:<br>
<ul>
<li><code>\bug, \deprecated, \throw, \internal, \note, \param, \remark, \sa, \todo, \warning</code> <em>(Multiple commands are allowed yielding a bulleted list)</em></li>
<li><code>\author, \brief, \return, \version</code> <em>(Only intended to be used once per entity)</em></li>
</ul>

</div>
<div class="paragraph2">See also</div>
<div id="descSee" class="paddingMembers"><LI><a href="#" OnMouseOver="link('_member','Internal2587069908',this)">Internal</a> (\internal) <br>
</div>
<div class="paragraph2">Todo</div>
<div id="descToDo" class="paddingMembers"><LI>We have stuff todo! <br>
</div>
<div class="padding">&nbsp;</div>
<table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderTop" height=1>
<TR><TD height=1 width=100% class="oneLine"></TD></TR></TABLE>
<div class="paragraph2">Source</div>
<div class="paddingMembers">The documentation for this Member was generated from the following files:</div>
<div class="paddingMembers"><LI><a href="#" onMouseOver="link('_file','HowtoDocument_cpp0',this); ">HowtoDocument.cpp</a><br><LI><a href="#" onMouseOver="link('_file','HowtoDocument_h0',this); ">HowtoDocument.h</a><br></div>
<div class="contentAirBottom"></div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_member','_description');
</script>
